<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Open SCA: File_impl Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="customdoxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.onetek.net"><img alt="Logo" src="openscaLogo.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Open SCA
   &#160;<span id="projectnumber">Version 0.6.0</span>
   </div>
   <div id="projectbrief">Open SCA</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('class_file__impl.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="class_file__impl-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">File_impl Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>The File interface provides the ability to read and write files residing within a compliant, distributed file system.  
 <a href="class_file__impl.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_file__impl_8h_source.html">File_impl.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for File_impl:</div>
<div class="dyncontent">
<div class="center"><img src="class_file__impl__inherit__graph.png" border="0" usemap="#_file__impl_inherit__map" alt="Inheritance graph"/></div>
<map name="_file__impl_inherit__map" id="_file__impl_inherit__map">
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a28a2b3f063e904bbdbcbd92219f6eae8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file__impl.html#a28a2b3f063e904bbdbcbd92219f6eae8">File_impl</a> (const char *<a class="el" href="class_file__impl.html#a2fb34edc76fc900779db733007cdd00d">fileName</a>, const char *root, bool readOnly, bool create)</td></tr>
<tr class="separator:a28a2b3f063e904bbdbcbd92219f6eae8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49b834254adbb460a7946edb6954b94a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file__impl.html#a49b834254adbb460a7946edb6954b94a">~File_impl</a> ()</td></tr>
<tr class="separator:a49b834254adbb460a7946edb6954b94a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ae591df94fc66ccb85cbb6565368bca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file__impl.html#a5ae591df94fc66ccb85cbb6565368bca">close</a> ()  throw (	    CF::FileException,	    CORBA::SystemException)</td></tr>
<tr class="memdesc:a5ae591df94fc66ccb85cbb6565368bca"><td class="mdescLeft">&#160;</td><td class="mdescRight">The close operation is needed in order to release file resources once they are no longer needed.  <a href="#a5ae591df94fc66ccb85cbb6565368bca">More...</a><br /></td></tr>
<tr class="separator:a5ae591df94fc66ccb85cbb6565368bca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2fb34edc76fc900779db733007cdd00d"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file__impl.html#a2fb34edc76fc900779db733007cdd00d">fileName</a> ()  throw (CORBA::SystemException)</td></tr>
<tr class="memdesc:a2fb34edc76fc900779db733007cdd00d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The operation shall return the pathname used as the input fileName parameter of the FileSystem::create operation when the file was created.  <a href="#a2fb34edc76fc900779db733007cdd00d">More...</a><br /></td></tr>
<tr class="separator:a2fb34edc76fc900779db733007cdd00d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3049ceae5f88e0bfadb432f036725f4f"><td class="memItemLeft" align="right" valign="top">CORBA::ULong&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file__impl.html#a3049ceae5f88e0bfadb432f036725f4f">filePointer</a> ()  throw (CORBA::SystemException)</td></tr>
<tr class="memdesc:a3049ceae5f88e0bfadb432f036725f4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The operation shall return the current file position.  <a href="#a3049ceae5f88e0bfadb432f036725f4f">More...</a><br /></td></tr>
<tr class="separator:a3049ceae5f88e0bfadb432f036725f4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e2bd46a25135e422187a5440b2492a0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file__impl.html#a2e2bd46a25135e422187a5440b2492a0">read</a> (CF::OctetSequence_out data, CORBA::ULong length)  throw (	    CF::File::IOException,	    CORBA::SystemException)</td></tr>
<tr class="memdesc:a2e2bd46a25135e422187a5440b2492a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Applications require the read operation in order to retrieve data from remote files.  <a href="#a2e2bd46a25135e422187a5440b2492a0">More...</a><br /></td></tr>
<tr class="separator:a2e2bd46a25135e422187a5440b2492a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adcb50f2c82d30fac17f8714fbeeeeb08"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file__impl.html#adcb50f2c82d30fac17f8714fbeeeeb08">setFilePointer</a> (CORBA::ULong _filePointer)  throw (	    CF::FileException,	    CF::File::InvalidFilePointer,	    CORBA::SystemException)</td></tr>
<tr class="memdesc:adcb50f2c82d30fac17f8714fbeeeeb08"><td class="mdescLeft">&#160;</td><td class="mdescRight">The setFilePointer operation positions the file pointer where the next read or write will occur.  <a href="#adcb50f2c82d30fac17f8714fbeeeeb08">More...</a><br /></td></tr>
<tr class="separator:adcb50f2c82d30fac17f8714fbeeeeb08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af74f43b2414f8c947bb58c1fb3d77c5f"><td class="memItemLeft" align="right" valign="top">CORBA::ULong&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file__impl.html#af74f43b2414f8c947bb58c1fb3d77c5f">sizeOf</a> ()  throw (	    CF::FileException,	    CORBA::SystemException)</td></tr>
<tr class="memdesc:af74f43b2414f8c947bb58c1fb3d77c5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">An application may need to know the size of a file in order to determine memory allocation requirements.  <a href="#af74f43b2414f8c947bb58c1fb3d77c5f">More...</a><br /></td></tr>
<tr class="separator:af74f43b2414f8c947bb58c1fb3d77c5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abedae68271fce255d9509577c809f086"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file__impl.html#abedae68271fce255d9509577c809f086">write</a> (const CF::OctetSequence &amp;data)  throw (	    CF::File::IOException,	    CORBA::SystemException)</td></tr>
<tr class="memdesc:abedae68271fce255d9509577c809f086"><td class="mdescLeft">&#160;</td><td class="mdescRight">Applications require the write operation in order to write data to remote files.  <a href="#abedae68271fce255d9509577c809f086">More...</a><br /></td></tr>
<tr class="separator:abedae68271fce255d9509577c809f086"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a1fcae833f5b173403d06fe353da96cde"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file__impl.html#a1fcae833f5b173403d06fe353da96cde">File_impl</a> ()</td></tr>
<tr class="memdesc:a1fcae833f5b173403d06fe353da96cde"><td class="mdescLeft">&#160;</td><td class="mdescRight">The File interface provides the ability to read and write files residing within a compliant, distributed file system.  <a href="#a1fcae833f5b173403d06fe353da96cde">More...</a><br /></td></tr>
<tr class="separator:a1fcae833f5b173403d06fe353da96cde"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a755d2a2edec51d5c364101c7d1582a11"><td class="memItemLeft" align="right" valign="top">std::fstream&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file__impl.html#a755d2a2edec51d5c364101c7d1582a11">m_fstm</a></td></tr>
<tr class="separator:a755d2a2edec51d5c364101c7d1582a11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8e266cbb595ab7f41a3ee5b4cb2715f"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file__impl.html#af8e266cbb595ab7f41a3ee5b4cb2715f">m_fName</a></td></tr>
<tr class="memdesc:af8e266cbb595ab7f41a3ee5b4cb2715f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The readonly fileName attribute shall contain the pathname used as the input fileName parameter of the FileSystem::create operation when the file was created.  <a href="#af8e266cbb595ab7f41a3ee5b4cb2715f">More...</a><br /></td></tr>
<tr class="separator:af8e266cbb595ab7f41a3ee5b4cb2715f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The File interface provides the ability to read and write files residing within a compliant, distributed file system. </p>
<p>A file can be thought of conceptually as a sequence of octets with a current filePointer describing where the next read or write will occur. This filePointer points to the beginning of the file upon construction of the file object. The File interface is modeled after the POSIX/C file interface. </p>

<p>Definition at line <a class="el" href="_file__impl_8h_source.html#l00034">34</a> of file <a class="el" href="_file__impl_8h_source.html">File_impl.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a28a2b3f063e904bbdbcbd92219f6eae8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_file__impl.html">File_impl</a> </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>fileName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>root</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>readOnly</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>create</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="_file__impl_8cpp_source.html#l00042">42</a> of file <a class="el" href="_file__impl_8cpp_source.html">File_impl.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a49b834254adbb460a7946edb6954b94a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">~<a class="el" href="class_file__impl.html">File_impl</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="_file__impl_8cpp_source.html#l00082">82</a> of file <a class="el" href="_file__impl_8cpp_source.html">File_impl.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a1fcae833f5b173403d06fe353da96cde"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_file__impl.html">File_impl</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The File interface provides the ability to read and write files residing within a compliant, distributed file system. </p>
<p>A file can be thought of conceptually as a sequence of octets with a current filePointer describing where the next read or write will occur. This filePointer points to the beginning of the file upon construction of the file object. The File interface is modeled after the POSIX/C file interface. </p>

<p>Definition at line <a class="el" href="_file__impl_8cpp_source.html#l00038">38</a> of file <a class="el" href="_file__impl_8cpp_source.html">File_impl.cpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a5ae591df94fc66ccb85cbb6565368bca"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void close </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
        <tr>
          <td align="right">throw </td><td>(</td><td colspan="2">	    CF::FileException,</td>
        </tr>
        <tr>
          <td align="right"></td><td></td><td colspan="2">CORBA::SystemException</td>
        </tr>
        <tr>
          <td align="right"></td><td>)</td><td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The close operation is needed in order to release file resources once they are no longer needed. </p>
<p>The close operation shall release any OE file resources associated with the component. The close operation shall make the file unavailable to the component. </p>

<p>Definition at line <a class="el" href="_file__impl_8cpp_source.html#l00087">87</a> of file <a class="el" href="_file__impl_8cpp_source.html">File_impl.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a2fb34edc76fc900779db733007cdd00d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">char* fileName </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
        <tr>
          <td align="right">throw </td><td>(</td><td colspan="2">CORBA::SystemException</td>
        </tr>
        <tr>
          <td align="right"></td><td>)</td><td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The operation shall return the pathname used as the input fileName parameter of the FileSystem::create operation when the file was created. </p>
<dl class="section return"><dt>Returns</dt><dd>Name of the file. </dd></dl>

<p>Definition at line <a class="el" href="_file__impl_8h_source.html#l00067">67</a> of file <a class="el" href="_file__impl_8h_source.html">File_impl.h</a>.</p>

</div>
</div>
<a class="anchor" id="a3049ceae5f88e0bfadb432f036725f4f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">CORBA::ULong filePointer </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
        <tr>
          <td align="right">throw </td><td>(</td><td colspan="2">CORBA::SystemException</td>
        </tr>
        <tr>
          <td align="right"></td><td>)</td><td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The operation shall return the current file position. </p>
<p>The filePointer attribute value dictates where the next read or write will occur.</p>
<dl class="section return"><dt>Returns</dt><dd>Current file position. </dd></dl>

<p>Definition at line <a class="el" href="_file__impl_8h_source.html#l00080">80</a> of file <a class="el" href="_file__impl_8h_source.html">File_impl.h</a>.</p>

</div>
</div>
<a class="anchor" id="a2e2bd46a25135e422187a5440b2492a0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void read </td>
          <td>(</td>
          <td class="paramtype">CF::OctetSequence_out&#160;</td>
          <td class="paramname"><em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">CORBA::ULong&#160;</td>
          <td class="paramname"><em>length</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
        <tr>
          <td align="right">throw </td><td>(</td><td colspan="2">	    CF::File::IOException,</td>
        </tr>
        <tr>
          <td align="right"></td><td></td><td colspan="2">CORBA::SystemException</td>
        </tr>
        <tr>
          <td align="right"></td><td>)</td><td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Applications require the read operation in order to retrieve data from remote files. </p>
<p>The read operation shall read, from the referenced file, the number of octets specified by the input length parameter and advance the value of the filePointer attribute by the number of octets actually read. The read operation shall read less than the number of octets specified in the inputlength parameter, when an end of file is encountered.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">data</td><td>Buffer to store data read. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>Length of data to read.</td></tr>
  </table>
  </dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">The</td><td>read operation shall raise the IOException when a read error occurs. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_file__impl_8cpp_source.html#l00102">102</a> of file <a class="el" href="_file__impl_8cpp_source.html">File_impl.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="adcb50f2c82d30fac17f8714fbeeeeb08"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void setFilePointer </td>
          <td>(</td>
          <td class="paramtype">CORBA::ULong&#160;</td>
          <td class="paramname"><em>_filePointer</em></td><td>)</td>
          <td></td>
        </tr>
        <tr>
          <td align="right">throw </td><td>(</td><td colspan="2">	    CF::FileException,</td>
        </tr>
        <tr>
          <td align="right"></td><td></td><td colspan="2">	    CF::File::InvalidFilePointer,</td>
        </tr>
        <tr>
          <td align="right"></td><td></td><td colspan="2">CORBA::SystemException</td>
        </tr>
        <tr>
          <td align="right"></td><td>)</td><td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The setFilePointer operation positions the file pointer where the next read or write will occur. </p>
<p>The setFilePointer operation shall set the filePointer attribute value to the input filePointer.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">_filePointer</td><td>Where the next read or write will occur.</td></tr>
  </table>
  </dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">The</td><td>setFilePointer operation shall raise the CF FileException when the file pointer for the referenced file cannot be set to the value of the input filePointer parameter.</td></tr>
  </table>
  </dd>
</dl>
<p>The setFilePointer operation shall raise the InvalidFilePointer exception when the value of the filePointer parameter exceeds the file size. </p>

<p>Definition at line <a class="el" href="_file__impl_8cpp_source.html#l00137">137</a> of file <a class="el" href="_file__impl_8cpp_source.html">File_impl.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="af74f43b2414f8c947bb58c1fb3d77c5f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CORBA::ULong sizeOf </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
        <tr>
          <td align="right">throw </td><td>(</td><td colspan="2">	    CF::FileException,</td>
        </tr>
        <tr>
          <td align="right"></td><td></td><td colspan="2">CORBA::SystemException</td>
        </tr>
        <tr>
          <td align="right"></td><td>)</td><td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>An application may need to know the size of a file in order to determine memory allocation requirements. </p>
<p>There is no significant behavior beyond the behavior described by the following section.</p>
<dl class="section return"><dt>Returns</dt><dd>The sizeOf operation shall return the number of octets stored in the file.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">The</td><td>sizeOf operation shall raise the CF FileException when a file-related error occurs (e.g., file does not exist anymore). </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_file__impl_8cpp_source.html#l00163">163</a> of file <a class="el" href="_file__impl_8cpp_source.html">File_impl.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="abedae68271fce255d9509577c809f086"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void write </td>
          <td>(</td>
          <td class="paramtype">const CF::OctetSequence &amp;&#160;</td>
          <td class="paramname"><em>data</em></td><td>)</td>
          <td></td>
        </tr>
        <tr>
          <td align="right">throw </td><td>(</td><td colspan="2">	    CF::File::IOException,</td>
        </tr>
        <tr>
          <td align="right"></td><td></td><td colspan="2">CORBA::SystemException</td>
        </tr>
        <tr>
          <td align="right"></td><td>)</td><td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Applications require the write operation in order to write data to remote files. </p>
<p>The write operation shall write data to the file referenced. The write operation shall increment the filePointer attribute to reflect the number of octets written, when the operation is successful.</p>
<p>If the write is unsuccessful, the value of the filePointer attribute shall maintain or be restored to its value prior to the write operation call. If the file was opened using the FileSystem::open operation with an input read_Only parameter value of TRUE, writes to the file are considered to be in error.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Data needs written.</td></tr>
  </table>
  </dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">The</td><td>write operation shall raise the IOException when a write error occurs. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_file__impl_8cpp_source.html#l00188">188</a> of file <a class="el" href="_file__impl_8cpp_source.html">File_impl.cpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="af8e266cbb595ab7f41a3ee5b4cb2715f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::string m_fName</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The readonly fileName attribute shall contain the pathname used as the input fileName parameter of the FileSystem::create operation when the file was created. </p>

<p>Definition at line <a class="el" href="_file__impl_8h_source.html#l00183">183</a> of file <a class="el" href="_file__impl_8h_source.html">File_impl.h</a>.</p>

</div>
</div>
<a class="anchor" id="a755d2a2edec51d5c364101c7d1582a11"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::fstream m_fstm</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="_file__impl_8h_source.html#l00178">178</a> of file <a class="el" href="_file__impl_8h_source.html">File_impl.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>frameworks/File/include/<a class="el" href="_file__impl_8h_source.html">File_impl.h</a></li>
<li>frameworks/File/src/<a class="el" href="_file__impl_8cpp_source.html">File_impl.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.13-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="class_file__impl.html">File_impl</a></li>
    <li class="footer">Generated on Fri Jul 12 2019 14:31:54 for
    <a href="http://www.onetek.net">
    <img class="footer" src="openscaLogo.png" height="31" alt="openSCA"/></a>
    </li>
  </ul>
</div>
</body>
</html>
